3 * Base code for MediaWiki installer.
5 * DO NOT PATCH THIS FILE IF YOU NEED TO CHANGE INSTALLER BEHAVIOR IN YOUR PACKAGE!
6 * See mw-config/overrides/README for details.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 * http://www.gnu.org/copyleft/gpl.html
26 use MediaWiki\MediaWikiServices
;
29 * This documentation group collects source code files with deployment functionality.
31 * @defgroup Deployment Deployment
35 * Base installer class.
37 * This class provides the base for installation and update functionality
38 * for both MediaWiki core and extensions.
43 abstract class Installer
{
46 * The oldest version of PCRE we can support.
48 * Defining this is necessary because PHP may be linked with a system version
49 * of PCRE, which may be older than that bundled with the minimum PHP version.
51 const MINIMUM_PCRE_VERSION
= '7.2';
59 * List of detected DBs, access using getCompiledDBs().
63 protected $compiledDBs;
66 * Cached DB installer instances, access using getDBInstaller().
70 protected $dbInstallers = [];
73 * Minimum memory size in MB.
77 protected $minMemorySize = 50;
80 * Cached Title, used by parse().
84 protected $parserTitle;
87 * Cached ParserOptions, used by parse().
91 protected $parserOptions;
94 * Known database types. These correspond to the class names <type>Installer,
95 * and are also MediaWiki database types valid for $wgDBtype.
97 * To add a new type, create a <type>Installer class and a Database<type>
98 * class, and add a config-type-<type> message to MessagesEn.php.
102 protected static $dbTypes = [
111 * A list of environment check methods called by doEnvironmentChecks().
112 * These may output warnings using showMessage(), and/or abort the
113 * installation process by returning false.
115 * For the WebInstaller these are only called on the Welcome page,
116 * if these methods have side-effects that should affect later page loads
117 * (as well as the generated stylesheet), use envPreps instead.
121 protected $envChecks = [
127 'envCheckModSecurity',
133 'envCheckShellLocale',
134 'envCheckUploadsDirectory',
136 'envCheckSuhosinMaxValueLength',
140 * A list of environment preparation methods called by doEnvironmentPreps().
144 protected $envPreps = [
150 * MediaWiki configuration globals that will eventually be passed through
151 * to LocalSettings.php. The names only are given here, the defaults
152 * typically come from DefaultSettings.php.
156 protected $defaultVarNames = [
167 'wgEmailAuthentication',
171 'wgImageMagickConvertCommand',
176 'wgDeletedDirectory',
180 'wgUseInstantCommons',
187 * Variables that are stored alongside globals, and are used for any
188 * configuration of the installation process aside from the MediaWiki
189 * configuration. Map of names to defaults.
193 protected $internalDefaults = [
195 '_Environment' => false,
196 '_RaiseMemory' => false,
197 '_UpgradeDone' => false,
198 '_InstallDone' => false,
200 '_InstallPassword' => '',
201 '_SameAccount' => true,
202 '_CreateDBAccount' => false,
203 '_NamespaceType' => 'site-name',
204 '_AdminName' => '', // will be set later, when the user selects language
205 '_AdminPassword' => '',
206 '_AdminPasswordConfirm' => '',
208 '_Subscribe' => false,
209 '_SkipOptional' => 'continue',
210 '_RightsProfile' => 'wiki',
211 '_LicenseCode' => 'none',
215 '_MemCachedServers' => '',
216 '_UpgradeKeySupplied' => false,
217 '_ExistingDBSettings' => false,
219 // $wgLogo is probably wrong (T50084); set something that will work.
220 // Single quotes work fine here, as LocalSettingsGenerator outputs this unescaped.
221 'wgLogo' => '$wgResourceBasePath/resources/assets/wiki.png',
222 'wgAuthenticationTokenVersion' => 1,
226 * The actual list of installation steps. This will be initialized by getInstallSteps()
230 private $installSteps = [];
233 * Extra steps for installation, for things like DatabaseInstallers to modify
237 protected $extraInstallSteps = [];
240 * Known object cache types and the functions used to test for their existence.
244 protected $objectCaches = [
245 'xcache' => 'xcache_get',
246 'apc' => 'apc_fetch',
247 'apcu' => 'apcu_fetch',
248 'wincache' => 'wincache_ucache_get'
252 * User rights profiles.
256 public $rightsProfiles = [
259 '*' => [ 'edit' => false ]
263 'createaccount' => false,
269 'createaccount' => false,
283 'url' => 'https://creativecommons.org/licenses/by/4.0/',
284 'icon' => '$wgResourceBasePath/resources/assets/licenses/cc-by.png',
287 'url' => 'https://creativecommons.org/licenses/by-sa/4.0/',
288 'icon' => '$wgResourceBasePath/resources/assets/licenses/cc-by-sa.png',
291 'url' => 'https://creativecommons.org/licenses/by-nc-sa/4.0/',
292 'icon' => '$wgResourceBasePath/resources/assets/licenses/cc-by-nc-sa.png',
295 'url' => 'https://creativecommons.org/publicdomain/zero/1.0/',
296 'icon' => '$wgResourceBasePath/resources/assets/licenses/cc-0.png',
299 'url' => 'https://www.gnu.org/copyleft/fdl.html',
300 'icon' => '$wgResourceBasePath/resources/assets/licenses/gnu-fdl.png',
308 // Details will be filled in by the selector.
316 * URL to mediawiki-announce subscription
318 protected $mediaWikiAnnounceUrl =
319 'https://lists.wikimedia.org/mailman/subscribe/mediawiki-announce';
322 * Supported language codes for Mailman
324 protected $mediaWikiAnnounceLanguages = [
325 'ca', 'cs', 'da', 'de', 'en', 'es', 'et', 'eu', 'fi', 'fr', 'hr', 'hu',
326 'it', 'ja', 'ko', 'lt', 'nl', 'no', 'pl', 'pt', 'pt-br', 'ro', 'ru',
327 'sl', 'sr', 'sv', 'tr', 'uk'
331 * UI interface for displaying a short message
332 * The parameters are like parameters to wfMessage().
333 * The messages will be in wikitext format, which will be converted to an
334 * output format such as HTML or text before being sent to the user.
337 abstract public function showMessage( $msg /*, ... */ );
340 * Same as showMessage(), but for displaying errors
343 abstract public function showError( $msg /*, ... */ );
346 * Show a message to the installing user by using a Status object
347 * @param Status $status
349 abstract public function showStatusMessage( Status
$status );
352 * Constructs a Config object that contains configuration settings that should be
353 * overwritten for the installation process.
357 * @param Config $baseConfig
359 * @return Config The config to use during installation.
361 public static function getInstallerConfig( Config
$baseConfig ) {
362 $configOverrides = new HashConfig();
364 // disable (problematic) object cache types explicitly, preserving all other (working) ones
366 $emptyCache = [ 'class' => 'EmptyBagOStuff' ];
369 CACHE_NONE
=> $emptyCache,
370 CACHE_DB
=> $emptyCache,
371 CACHE_ANYTHING
=> $emptyCache,
372 CACHE_MEMCACHED
=> $emptyCache,
373 ] +
$baseConfig->get( 'ObjectCaches' );
375 $configOverrides->set( 'ObjectCaches', $objectCaches );
377 // Load the installer's i18n.
378 $messageDirs = $baseConfig->get( 'MessagesDirs' );
379 $messageDirs['MediawikiInstaller'] = __DIR__
. '/i18n';
381 $configOverrides->set( 'MessagesDirs', $messageDirs );
383 $installerConfig = new MultiConfig( [ $configOverrides, $baseConfig ] );
385 // make sure we use the installer config as the main config
386 $configRegistry = $baseConfig->get( 'ConfigRegistry' );
387 $configRegistry['main'] = function () use ( $installerConfig ) {
388 return $installerConfig;
391 $configOverrides->set( 'ConfigRegistry', $configRegistry );
393 return $installerConfig;
397 * Constructor, always call this from child classes.
399 public function __construct() {
400 global $wgMemc, $wgUser, $wgObjectCaches;
402 $defaultConfig = new GlobalVarConfig(); // all the stuff from DefaultSettings.php
403 $installerConfig = self
::getInstallerConfig( $defaultConfig );
405 // Reset all services and inject config overrides
406 MediaWiki\MediaWikiServices
::resetGlobalInstance( $installerConfig );
408 // Don't attempt to load user language options (T126177)
409 // This will be overridden in the web installer with the user-specified language
410 RequestContext
::getMain()->setLanguage( 'en' );
412 // Disable the i18n cache
413 // TODO: manage LocalisationCache singleton in MediaWikiServices
414 Language
::getLocalisationCache()->disableBackend();
416 // Disable all global services, since we don't have any configuration yet!
417 MediaWiki\MediaWikiServices
::disableStorageBackend();
419 // Disable object cache (otherwise CACHE_ANYTHING will try CACHE_DB and
420 // SqlBagOStuff will then throw since we just disabled wfGetDB)
421 $wgObjectCaches = MediaWikiServices
::getInstance()->getMainConfig()->get( 'ObjectCaches' );
422 $wgMemc = ObjectCache
::getInstance( CACHE_NONE
);
424 // Having a user with id = 0 safeguards us from DB access via User::loadOptions().
425 $wgUser = User
::newFromId( 0 );
426 RequestContext
::getMain()->setUser( $wgUser );
428 $this->settings
= $this->internalDefaults
;
430 foreach ( $this->defaultVarNames
as $var ) {
431 $this->settings
[$var] = $GLOBALS[$var];
434 $this->doEnvironmentPreps();
436 $this->compiledDBs
= [];
437 foreach ( self
::getDBTypes() as $type ) {
438 $installer = $this->getDBInstaller( $type );
440 if ( !$installer->isCompiled() ) {
443 $this->compiledDBs
[] = $type;
446 $this->parserTitle
= Title
::newFromText( 'Installer' );
447 $this->parserOptions
= new ParserOptions( $wgUser ); // language will be wrong :(
448 $this->parserOptions
->setEditSection( false );
449 $this->parserOptions
->setWrapOutputClass( false );
450 // Don't try to access DB before user language is initialised
451 $this->setParserLanguage( Language
::factory( 'en' ) );
455 * Get a list of known DB types.
459 public static function getDBTypes() {
460 return self
::$dbTypes;
464 * Do initial checks of the PHP environment. Set variables according to
465 * the observed environment.
467 * It's possible that this may be called under the CLI SAPI, not the SAPI
468 * that the wiki will primarily run under. In that case, the subclass should
469 * initialise variables such as wgScriptPath, before calling this function.
471 * Under the web subclass, it can already be assumed that PHP 5+ is in use
472 * and that sessions are working.
476 public function doEnvironmentChecks() {
477 // Php version has already been checked by entry scripts
478 // Show message here for information purposes
480 $this->showMessage( 'config-env-hhvm', HHVM_VERSION
);
482 $this->showMessage( 'config-env-php', PHP_VERSION
);
486 // Must go here because an old version of PCRE can prevent other checks from completing
487 list( $pcreVersion ) = explode( ' ', PCRE_VERSION
, 2 );
488 if ( version_compare( $pcreVersion, self
::MINIMUM_PCRE_VERSION
, '<' ) ) {
489 $this->showError( 'config-pcre-old', self
::MINIMUM_PCRE_VERSION
, $pcreVersion );
492 foreach ( $this->envChecks
as $check ) {
493 $status = $this->$check();
494 if ( $status === false ) {
500 $this->setVar( '_Environment', $good );
502 return $good ? Status
::newGood() : Status
::newFatal( 'config-env-bad' );
505 public function doEnvironmentPreps() {
506 foreach ( $this->envPreps
as $prep ) {
512 * Set a MW configuration variable, or internal installer configuration variable.
514 * @param string $name
515 * @param mixed $value
517 public function setVar( $name, $value ) {
518 $this->settings
[$name] = $value;
522 * Get an MW configuration variable, or internal installer configuration variable.
523 * The defaults come from $GLOBALS (ultimately DefaultSettings.php).
524 * Installer variables are typically prefixed by an underscore.
526 * @param string $name
527 * @param mixed $default
531 public function getVar( $name, $default = null ) {
532 if ( !isset( $this->settings
[$name] ) ) {
535 return $this->settings
[$name];
540 * Get a list of DBs supported by current PHP setup
544 public function getCompiledDBs() {
545 return $this->compiledDBs
;
549 * Get an instance of DatabaseInstaller for the specified DB type.
551 * @param mixed $type DB installer for which is needed, false to use default.
553 * @return DatabaseInstaller
555 public function getDBInstaller( $type = false ) {
557 $type = $this->getVar( 'wgDBtype' );
560 $type = strtolower( $type );
562 if ( !isset( $this->dbInstallers
[$type] ) ) {
563 $class = ucfirst( $type ) . 'Installer';
564 $this->dbInstallers
[$type] = new $class( $this );
567 return $this->dbInstallers
[$type];
571 * Determine if LocalSettings.php exists. If it does, return its variables.
573 * @return array|false
575 public static function getExistingLocalSettings() {
578 // You might be wondering why this is here. Well if you don't do this
579 // then some poorly-formed extensions try to call their own classes
580 // after immediately registering them. We really need to get extension
581 // registration out of the global scope and into a real format.
582 // @see https://phabricator.wikimedia.org/T69440
583 global $wgAutoloadClasses;
584 $wgAutoloadClasses = [];
586 // @codingStandardsIgnoreStart
587 // LocalSettings.php should not call functions, except wfLoadSkin/wfLoadExtensions
588 // Define the required globals here, to ensure, the functions can do it work correctly.
589 global $wgExtensionDirectory, $wgStyleDirectory;
590 // @codingStandardsIgnoreEnd
592 MediaWiki\
suppressWarnings();
593 $_lsExists = file_exists( "$IP/LocalSettings.php" );
594 MediaWiki\restoreWarnings
();
601 require "$IP/includes/DefaultSettings.php";
602 require "$IP/LocalSettings.php";
604 return get_defined_vars();
608 * Get a fake password for sending back to the user in HTML.
609 * This is a security mechanism to avoid compromise of the password in the
610 * event of session ID compromise.
612 * @param string $realPassword
616 public function getFakePassword( $realPassword ) {
617 return str_repeat( '*', strlen( $realPassword ) );
621 * Set a variable which stores a password, except if the new value is a
622 * fake password in which case leave it as it is.
624 * @param string $name
625 * @param mixed $value
627 public function setPassword( $name, $value ) {
628 if ( !preg_match( '/^\*+$/', $value ) ) {
629 $this->setVar( $name, $value );
634 * On POSIX systems return the primary group of the webserver we're running under.
635 * On other systems just returns null.
637 * This is used to advice the user that he should chgrp his mw-config/data/images directory as the
638 * webserver user before he can install.
640 * Public because SqliteInstaller needs it, and doesn't subclass Installer.
644 public static function maybeGetWebserverPrimaryGroup() {
645 if ( !function_exists( 'posix_getegid' ) ||
!function_exists( 'posix_getpwuid' ) ) {
646 # I don't know this, this isn't UNIX.
650 # posix_getegid() *not* getmygid() because we want the group of the webserver,
651 # not whoever owns the current script.
652 $gid = posix_getegid();
653 $group = posix_getpwuid( $gid )['name'];
659 * Convert wikitext $text to HTML.
661 * This is potentially error prone since many parser features require a complete
662 * installed MW database. The solution is to just not use those features when you
663 * write your messages. This appears to work well enough. Basic formatting and
664 * external links work just fine.
666 * But in case a translator decides to throw in a "#ifexist" or internal link or
667 * whatever, this function is guarded to catch the attempted DB access and to present
668 * some fallback text.
670 * @param string $text
671 * @param bool $lineStart
674 public function parse( $text, $lineStart = false ) {
678 $out = $wgParser->parse( $text, $this->parserTitle
, $this->parserOptions
, $lineStart );
679 $html = $out->getText();
680 } catch ( MediaWiki\Services\ServiceDisabledException
$e ) {
681 $html = '<!--DB access attempted during parse--> ' . htmlspecialchars( $text );
683 if ( !empty( $this->debug
) ) {
684 $html .= "<!--\n" . $e->getTraceAsString() . "\n-->";
692 * @return ParserOptions
694 public function getParserOptions() {
695 return $this->parserOptions
;
698 public function disableLinkPopups() {
699 $this->parserOptions
->setExternalLinkTarget( false );
702 public function restoreLinkPopups() {
703 global $wgExternalLinkTarget;
704 $this->parserOptions
->setExternalLinkTarget( $wgExternalLinkTarget );
708 * Install step which adds a row to the site_stats table with appropriate
711 * @param DatabaseInstaller $installer
715 public function populateSiteStats( DatabaseInstaller
$installer ) {
716 $status = $installer->getConnection();
717 if ( !$status->isOK() ) {
720 $status->value
->insert(
724 'ss_total_edits' => 0,
725 'ss_good_articles' => 0,
726 'ss_total_pages' => 0,
728 'ss_active_users' => 0,
734 return Status
::newGood();
738 * Environment check for DB types.
741 protected function envCheckDB() {
746 // Messages: config-type-mysql, config-type-postgres, config-type-oracle,
747 // config-type-sqlite
748 foreach ( self
::getDBTypes() as $name ) {
749 $allNames[] = wfMessage( "config-type-$name" )->text();
752 $databases = $this->getCompiledDBs();
754 $databases = array_flip( $databases );
755 foreach ( array_keys( $databases ) as $db ) {
756 $installer = $this->getDBInstaller( $db );
757 $status = $installer->checkPrerequisites();
758 if ( !$status->isGood() ) {
759 $this->showStatusMessage( $status );
761 if ( !$status->isOK() ) {
762 unset( $databases[$db] );
765 $databases = array_flip( $databases );
767 $this->showError( 'config-no-db', $wgLang->commaList( $allNames ), count( $allNames ) );
769 // @todo FIXME: This only works for the web installer!
777 * Some versions of libxml+PHP break < and > encoding horribly
780 protected function envCheckBrokenXML() {
781 $test = new PhpXmlBugTester();
783 $this->showError( 'config-brokenlibxml' );
792 * Environment check for the PCRE module.
794 * @note If this check were to fail, the parser would
795 * probably throw an exception before the result
796 * of this check is shown to the user.
799 protected function envCheckPCRE() {
800 MediaWiki\
suppressWarnings();
801 $regexd = preg_replace( '/[\x{0430}-\x{04FF}]/iu', '', '-АБВГД-' );
802 // Need to check for \p support too, as PCRE can be compiled
803 // with utf8 support, but not unicode property support.
804 // check that \p{Zs} (space separators) matches
805 // U+3000 (Ideographic space)
806 $regexprop = preg_replace( '/\p{Zs}/u', '', "-\xE3\x80\x80-" );
807 MediaWiki\restoreWarnings
();
808 if ( $regexd != '--' ||
$regexprop != '--' ) {
809 $this->showError( 'config-pcre-no-utf8' );
818 * Environment check for available memory.
821 protected function envCheckMemory() {
822 $limit = ini_get( 'memory_limit' );
824 if ( !$limit ||
$limit == -1 ) {
828 $n = wfShorthandToInteger( $limit );
830 if ( $n < $this->minMemorySize
* 1024 * 1024 ) {
831 $newLimit = "{$this->minMemorySize}M";
833 if ( ini_set( "memory_limit", $newLimit ) === false ) {
834 $this->showMessage( 'config-memory-bad', $limit );
836 $this->showMessage( 'config-memory-raised', $limit, $newLimit );
837 $this->setVar( '_RaiseMemory', true );
845 * Environment check for compiled object cache types.
847 protected function envCheckCache() {
849 foreach ( $this->objectCaches
as $name => $function ) {
850 if ( function_exists( $function ) ) {
851 if ( $name == 'xcache' && !wfIniGetBool( 'xcache.var_size' ) ) {
854 $caches[$name] = true;
859 $key = 'config-no-cache-apcu';
860 $this->showMessage( $key );
863 $this->setVar( '_Caches', $caches );
867 * Scare user to death if they have mod_security or mod_security2
870 protected function envCheckModSecurity() {
871 if ( self
::apacheModulePresent( 'mod_security' )
872 || self
::apacheModulePresent( 'mod_security2' ) ) {
873 $this->showMessage( 'config-mod-security' );
880 * Search for GNU diff3.
883 protected function envCheckDiff3() {
884 $names = [ "gdiff3", "diff3", "diff3.exe" ];
885 $versionInfo = [ '$1 --version 2>&1', 'GNU diffutils' ];
887 $diff3 = self
::locateExecutableInDefaultPaths( $names, $versionInfo );
890 $this->setVar( 'wgDiff3', $diff3 );
892 $this->setVar( 'wgDiff3', false );
893 $this->showMessage( 'config-diff3-bad' );
900 * Environment check for ImageMagick and GD.
903 protected function envCheckGraphics() {
904 $names = [ wfIsWindows() ?
'convert.exe' : 'convert' ];
905 $versionInfo = [ '$1 -version', 'ImageMagick' ];
906 $convert = self
::locateExecutableInDefaultPaths( $names, $versionInfo );
908 $this->setVar( 'wgImageMagickConvertCommand', '' );
910 $this->setVar( 'wgImageMagickConvertCommand', $convert );
911 $this->showMessage( 'config-imagemagick', $convert );
914 } elseif ( function_exists( 'imagejpeg' ) ) {
915 $this->showMessage( 'config-gd' );
917 $this->showMessage( 'config-no-scaling' );
929 protected function envCheckGit() {
930 $names = [ wfIsWindows() ?
'git.exe' : 'git' ];
931 $versionInfo = [ '$1 --version', 'git version' ];
933 $git = self
::locateExecutableInDefaultPaths( $names, $versionInfo );
936 $this->setVar( 'wgGitBin', $git );
937 $this->showMessage( 'config-git', $git );
939 $this->setVar( 'wgGitBin', false );
940 $this->showMessage( 'config-git-bad' );
947 * Environment check to inform user which server we've assumed.
951 protected function envCheckServer() {
952 $server = $this->envGetDefaultServer();
953 if ( $server !== null ) {
954 $this->showMessage( 'config-using-server', $server );
960 * Environment check to inform user which paths we've assumed.
964 protected function envCheckPath() {
967 $this->getVar( 'wgServer' ),
968 $this->getVar( 'wgScriptPath' )
974 * Environment check for preferred locale in shell
977 protected function envCheckShellLocale() {
978 $os = php_uname( 's' );
979 $supported = [ 'Linux', 'SunOS', 'HP-UX', 'Darwin' ]; # Tested these
981 if ( !in_array( $os, $supported ) ) {
985 # Get a list of available locales.
987 $lines = wfShellExec( '/usr/bin/locale -a', $ret );
993 $lines = array_map( 'trim', explode( "\n", $lines ) );
994 $candidatesByLocale = [];
995 $candidatesByLang = [];
997 foreach ( $lines as $line ) {
998 if ( $line === '' ) {
1002 if ( !preg_match( '/^([a-zA-Z]+)(_[a-zA-Z]+|)\.(utf8|UTF-8)(@[a-zA-Z_]*|)$/i', $line, $m ) ) {
1006 list( , $lang, , , ) = $m;
1008 $candidatesByLocale[$m[0]] = $m;
1009 $candidatesByLang[$lang][] = $m;
1012 # Try the current value of LANG.
1013 if ( isset( $candidatesByLocale[getenv( 'LANG' )] ) ) {
1014 $this->setVar( 'wgShellLocale', getenv( 'LANG' ) );
1019 # Try the most common ones.
1020 $commonLocales = [ 'C.UTF-8', 'en_US.UTF-8', 'en_US.utf8', 'de_DE.UTF-8', 'de_DE.utf8' ];
1021 foreach ( $commonLocales as $commonLocale ) {
1022 if ( isset( $candidatesByLocale[$commonLocale] ) ) {
1023 $this->setVar( 'wgShellLocale', $commonLocale );
1029 # Is there an available locale in the Wiki's language?
1030 $wikiLang = $this->getVar( 'wgLanguageCode' );
1032 if ( isset( $candidatesByLang[$wikiLang] ) ) {
1033 $m = reset( $candidatesByLang[$wikiLang] );
1034 $this->setVar( 'wgShellLocale', $m[0] );
1039 # Are there any at all?
1040 if ( count( $candidatesByLocale ) ) {
1041 $m = reset( $candidatesByLocale );
1042 $this->setVar( 'wgShellLocale', $m[0] );
1052 * Environment check for the permissions of the uploads directory
1055 protected function envCheckUploadsDirectory() {
1058 $dir = $IP . '/images/';
1059 $url = $this->getVar( 'wgServer' ) . $this->getVar( 'wgScriptPath' ) . '/images/';
1060 $safe = !$this->dirIsExecutable( $dir, $url );
1063 $this->showMessage( 'config-uploads-not-safe', $dir );
1070 * Checks if suhosin.get.max_value_length is set, and if so generate
1071 * a warning because it decreases ResourceLoader performance.
1074 protected function envCheckSuhosinMaxValueLength() {
1075 $maxValueLength = ini_get( 'suhosin.get.max_value_length' );
1076 if ( $maxValueLength > 0 && $maxValueLength < 1024 ) {
1077 // Only warn if the value is below the sane 1024
1078 $this->showMessage( 'config-suhosin-max-value-length', $maxValueLength );
1085 * Convert a hex string representing a Unicode code point to that code point.
1087 * @return string|false
1089 protected function unicodeChar( $c ) {
1093 } elseif ( $c <= 0x7FF ) {
1094 return chr( 0xC0 |
$c >> 6 ) . chr( 0x80 |
$c & 0x3F );
1095 } elseif ( $c <= 0xFFFF ) {
1096 return chr( 0xE0 |
$c >> 12 ) . chr( 0x80 |
$c >> 6 & 0x3F ) .
1097 chr( 0x80 |
$c & 0x3F );
1098 } elseif ( $c <= 0x10FFFF ) {
1099 return chr( 0xF0 |
$c >> 18 ) . chr( 0x80 |
$c >> 12 & 0x3F ) .
1100 chr( 0x80 |
$c >> 6 & 0x3F ) .
1101 chr( 0x80 |
$c & 0x3F );
1108 * Check the libicu version
1110 protected function envCheckLibicu() {
1112 * This needs to be updated something that the latest libicu
1113 * will properly normalize. This normalization was found at
1114 * http://www.unicode.org/versions/Unicode5.2.0/#Character_Additions
1115 * Note that we use the hex representation to create the code
1116 * points in order to avoid any Unicode-destroying during transit.
1118 $not_normal_c = $this->unicodeChar( "FA6C" );
1119 $normal_c = $this->unicodeChar( "242EE" );
1121 $useNormalizer = 'php';
1122 $needsUpdate = false;
1124 if ( function_exists( 'normalizer_normalize' ) ) {
1125 $useNormalizer = 'intl';
1126 $intl = normalizer_normalize( $not_normal_c, Normalizer
::FORM_C
);
1127 if ( $intl !== $normal_c ) {
1128 $needsUpdate = true;
1132 // Uses messages 'config-unicode-using-php' and 'config-unicode-using-intl'
1133 if ( $useNormalizer === 'php' ) {
1134 $this->showMessage( 'config-unicode-pure-php-warning' );
1136 $this->showMessage( 'config-unicode-using-' . $useNormalizer );
1137 if ( $needsUpdate ) {
1138 $this->showMessage( 'config-unicode-update-warning' );
1144 * Environment prep for the server hostname.
1146 protected function envPrepServer() {
1147 $server = $this->envGetDefaultServer();
1148 if ( $server !== null ) {
1149 $this->setVar( 'wgServer', $server );
1154 * Helper function to be called from envPrepServer()
1157 abstract protected function envGetDefaultServer();
1160 * Environment prep for setting $IP and $wgScriptPath.
1162 protected function envPrepPath() {
1164 $IP = dirname( dirname( __DIR__
) );
1165 $this->setVar( 'IP', $IP );
1169 * Get an array of likely places we can find executables. Check a bunch
1170 * of known Unix-like defaults, as well as the PATH environment variable
1171 * (which should maybe make it work for Windows?)
1175 protected static function getPossibleBinPaths() {
1177 [ '/usr/bin', '/usr/local/bin', '/opt/csw/bin',
1178 '/usr/gnu/bin', '/usr/sfw/bin', '/sw/bin', '/opt/local/bin' ],
1179 explode( PATH_SEPARATOR
, getenv( 'PATH' ) )
1184 * Search a path for any of the given executable names. Returns the
1185 * executable name if found. Also checks the version string returned
1186 * by each executable.
1188 * Used only by environment checks.
1190 * @param string $path Path to search
1191 * @param array $names Array of executable names
1192 * @param array|bool $versionInfo False or array with two members:
1193 * 0 => Command to run for version check, with $1 for the full executable name
1194 * 1 => String to compare the output with
1196 * If $versionInfo is not false, only executables with a version
1197 * matching $versionInfo[1] will be returned.
1198 * @return bool|string
1200 public static function locateExecutable( $path, $names, $versionInfo = false ) {
1201 if ( !is_array( $names ) ) {
1202 $names = [ $names ];
1205 foreach ( $names as $name ) {
1206 $command = $path . DIRECTORY_SEPARATOR
. $name;
1208 MediaWiki\
suppressWarnings();
1209 $file_exists = is_executable( $command );
1210 MediaWiki\restoreWarnings
();
1212 if ( $file_exists ) {
1213 if ( !$versionInfo ) {
1217 $file = str_replace( '$1', wfEscapeShellArg( $command ), $versionInfo[0] );
1218 if ( strstr( wfShellExec( $file ), $versionInfo[1] ) !== false ) {
1228 * Same as locateExecutable(), but checks in getPossibleBinPaths() by default
1229 * @see locateExecutable()
1230 * @param array $names Array of possible names.
1231 * @param array|bool $versionInfo Default: false or array with two members:
1232 * 0 => Command to run for version check, with $1 for the full executable name
1233 * 1 => String to compare the output with
1235 * If $versionInfo is not false, only executables with a version
1236 * matching $versionInfo[1] will be returned.
1237 * @return bool|string
1239 public static function locateExecutableInDefaultPaths( $names, $versionInfo = false ) {
1240 foreach ( self
::getPossibleBinPaths() as $path ) {
1241 $exe = self
::locateExecutable( $path, $names, $versionInfo );
1242 if ( $exe !== false ) {
1251 * Checks if scripts located in the given directory can be executed via the given URL.
1253 * Used only by environment checks.
1254 * @param string $dir
1255 * @param string $url
1256 * @return bool|int|string
1258 public function dirIsExecutable( $dir, $url ) {
1261 "<?php echo 'ex' . 'ec';",
1262 "#!/var/env php5\n<?php echo 'ex' . 'ec';",
1266 // it would be good to check other popular languages here, but it'll be slow.
1268 MediaWiki\
suppressWarnings();
1270 foreach ( $scriptTypes as $ext => $contents ) {
1271 foreach ( $contents as $source ) {
1272 $file = 'exectest.' . $ext;
1274 if ( !file_put_contents( $dir . $file, $source ) ) {
1279 $text = Http
::get( $url . $file, [ 'timeout' => 3 ], __METHOD__
);
1280 } catch ( Exception
$e ) {
1281 // Http::get throws with allow_url_fopen = false and no curl extension.
1284 unlink( $dir . $file );
1286 if ( $text == 'exec' ) {
1287 MediaWiki\restoreWarnings
();
1294 MediaWiki\restoreWarnings
();
1300 * Checks for presence of an Apache module. Works only if PHP is running as an Apache module, too.
1302 * @param string $moduleName Name of module to check.
1305 public static function apacheModulePresent( $moduleName ) {
1306 if ( function_exists( 'apache_get_modules' ) && in_array( $moduleName, apache_get_modules() ) ) {
1309 // try it the hard way
1311 phpinfo( INFO_MODULES
);
1312 $info = ob_get_clean();
1314 return strpos( $info, $moduleName ) !== false;
1318 * ParserOptions are constructed before we determined the language, so fix it
1320 * @param Language $lang
1322 public function setParserLanguage( $lang ) {
1323 $this->parserOptions
->setTargetLanguage( $lang );
1324 $this->parserOptions
->setUserLang( $lang );
1328 * Overridden by WebInstaller to provide lastPage parameters.
1329 * @param string $page
1332 protected function getDocUrl( $page ) {
1333 return "{$_SERVER['PHP_SELF']}?page=" . urlencode( $page );
1337 * Finds extensions that follow the format /$directory/Name/Name.php,
1338 * and returns an array containing the value for 'Name' for each found extension.
1340 * Reasonable values for $directory include 'extensions' (the default) and 'skins'.
1342 * @param string $directory Directory to search in
1345 public function findExtensions( $directory = 'extensions' ) {
1346 if ( $this->getVar( 'IP' ) === null ) {
1350 $extDir = $this->getVar( 'IP' ) . '/' . $directory;
1351 if ( !is_readable( $extDir ) ||
!is_dir( $extDir ) ) {
1355 // extensions -> extension.json, skins -> skin.json
1356 $jsonFile = substr( $directory, 0, strlen( $directory ) -1 ) . '.json';
1358 $dh = opendir( $extDir );
1360 while ( ( $file = readdir( $dh ) ) !== false ) {
1361 if ( !is_dir( "$extDir/$file" ) ) {
1364 if ( file_exists( "$extDir/$file/$jsonFile" ) ||
file_exists( "$extDir/$file/$file.php" ) ) {
1369 natcasesort( $exts );
1375 * Returns a default value to be used for $wgDefaultSkin: normally the one set in DefaultSettings,
1376 * but will fall back to another if the default skin is missing and some other one is present
1379 * @param string[] $skinNames Names of installed skins.
1382 public function getDefaultSkin( array $skinNames ) {
1383 $defaultSkin = $GLOBALS['wgDefaultSkin'];
1384 if ( !$skinNames ||
in_array( $defaultSkin, $skinNames ) ) {
1385 return $defaultSkin;
1387 return $skinNames[0];
1392 * Installs the auto-detected extensions.
1396 protected function includeExtensions() {
1398 $exts = $this->getVar( '_Extensions' );
1399 $IP = $this->getVar( 'IP' );
1402 * We need to include DefaultSettings before including extensions to avoid
1403 * warnings about unset variables. However, the only thing we really
1404 * want here is $wgHooks['LoadExtensionSchemaUpdates']. This won't work
1405 * if the extension has hidden hook registration in $wgExtensionFunctions,
1406 * but we're not opening that can of worms
1407 * @see https://phabricator.wikimedia.org/T28857
1409 global $wgAutoloadClasses;
1410 $wgAutoloadClasses = [];
1413 require "$IP/includes/DefaultSettings.php";
1415 foreach ( $exts as $e ) {
1416 if ( file_exists( "$IP/extensions/$e/extension.json" ) ) {
1417 $queue["$IP/extensions/$e/extension.json"] = 1;
1419 require_once "$IP/extensions/$e/$e.php";
1423 $registry = new ExtensionRegistry();
1424 $data = $registry->readFromQueue( $queue );
1425 $wgAutoloadClasses +
= $data['autoload'];
1427 $hooksWeWant = isset( $wgHooks['LoadExtensionSchemaUpdates'] ) ?
1428 /** @suppress PhanUndeclaredVariable $wgHooks is set by DefaultSettings */
1429 $wgHooks['LoadExtensionSchemaUpdates'] : [];
1431 if ( isset( $data['globals']['wgHooks']['LoadExtensionSchemaUpdates'] ) ) {
1432 $hooksWeWant = array_merge_recursive(
1434 $data['globals']['wgHooks']['LoadExtensionSchemaUpdates']
1437 // Unset everyone else's hooks. Lord knows what someone might be doing
1438 // in ParserFirstCallInit (see T29171)
1439 $GLOBALS['wgHooks'] = [ 'LoadExtensionSchemaUpdates' => $hooksWeWant ];
1441 return Status
::newGood();
1445 * Get an array of install steps. Should always be in the format of
1447 * 'name' => 'someuniquename',
1448 * 'callback' => [ $obj, 'method' ],
1450 * There must be a config-install-$name message defined per step, which will
1451 * be shown on install.
1453 * @param DatabaseInstaller $installer DatabaseInstaller so we can make callbacks
1456 protected function getInstallSteps( DatabaseInstaller
$installer ) {
1457 $coreInstallSteps = [
1458 [ 'name' => 'database', 'callback' => [ $installer, 'setupDatabase' ] ],
1459 [ 'name' => 'tables', 'callback' => [ $installer, 'createTables' ] ],
1460 [ 'name' => 'interwiki', 'callback' => [ $installer, 'populateInterwikiTable' ] ],
1461 [ 'name' => 'stats', 'callback' => [ $this, 'populateSiteStats' ] ],
1462 [ 'name' => 'keys', 'callback' => [ $this, 'generateKeys' ] ],
1463 [ 'name' => 'updates', 'callback' => [ $installer, 'insertUpdateKeys' ] ],
1464 [ 'name' => 'sysop', 'callback' => [ $this, 'createSysop' ] ],
1465 [ 'name' => 'mainpage', 'callback' => [ $this, 'createMainpage' ] ],
1468 // Build the array of install steps starting from the core install list,
1469 // then adding any callbacks that wanted to attach after a given step
1470 foreach ( $coreInstallSteps as $step ) {
1471 $this->installSteps
[] = $step;
1472 if ( isset( $this->extraInstallSteps
[$step['name']] ) ) {
1473 $this->installSteps
= array_merge(
1474 $this->installSteps
,
1475 $this->extraInstallSteps
[$step['name']]
1480 // Prepend any steps that want to be at the beginning
1481 if ( isset( $this->extraInstallSteps
['BEGINNING'] ) ) {
1482 $this->installSteps
= array_merge(
1483 $this->extraInstallSteps
['BEGINNING'],
1488 // Extensions should always go first, chance to tie into hooks and such
1489 if ( count( $this->getVar( '_Extensions' ) ) ) {
1490 array_unshift( $this->installSteps
,
1491 [ 'name' => 'extensions', 'callback' => [ $this, 'includeExtensions' ] ]
1493 $this->installSteps
[] = [
1494 'name' => 'extension-tables',
1495 'callback' => [ $installer, 'createExtensionTables' ]
1499 return $this->installSteps
;
1503 * Actually perform the installation.
1505 * @param callable $startCB A callback array for the beginning of each step
1506 * @param callable $endCB A callback array for the end of each step
1508 * @return array Array of Status objects
1510 public function performInstallation( $startCB, $endCB ) {
1511 $installResults = [];
1512 $installer = $this->getDBInstaller();
1513 $installer->preInstall();
1514 $steps = $this->getInstallSteps( $installer );
1515 foreach ( $steps as $stepObj ) {
1516 $name = $stepObj['name'];
1517 call_user_func_array( $startCB, [ $name ] );
1519 // Perform the callback step
1520 $status = call_user_func( $stepObj['callback'], $installer );
1522 // Output and save the results
1523 call_user_func( $endCB, $name, $status );
1524 $installResults[$name] = $status;
1526 // If we've hit some sort of fatal, we need to bail.
1527 // Callback already had a chance to do output above.
1528 if ( !$status->isOk() ) {
1532 if ( $status->isOk() ) {
1533 $this->setVar( '_InstallDone', true );
1536 return $installResults;
1540 * Generate $wgSecretKey. Will warn if we had to use an insecure random source.
1544 public function generateKeys() {
1545 $keys = [ 'wgSecretKey' => 64 ];
1546 if ( strval( $this->getVar( 'wgUpgradeKey' ) ) === '' ) {
1547 $keys['wgUpgradeKey'] = 16;
1550 return $this->doGenerateKeys( $keys );
1554 * Generate a secret value for variables using our CryptRand generator.
1555 * Produce a warning if the random source was insecure.
1557 * @param array $keys
1560 protected function doGenerateKeys( $keys ) {
1561 $status = Status
::newGood();
1564 foreach ( $keys as $name => $length ) {
1565 $secretKey = MWCryptRand
::generateHex( $length, true );
1566 if ( !MWCryptRand
::wasStrong() ) {
1570 $this->setVar( $name, $secretKey );
1574 $names = array_keys( $keys );
1575 $names = preg_replace( '/^(.*)$/', '\$$1', $names );
1577 $status->warning( 'config-insecure-keys', $wgLang->listToText( $names ), count( $names ) );
1584 * Create the first user account, grant it sysop and bureaucrat rights
1588 protected function createSysop() {
1589 $name = $this->getVar( '_AdminName' );
1590 $user = User
::newFromName( $name );
1593 // We should've validated this earlier anyway!
1594 return Status
::newFatal( 'config-admin-error-user', $name );
1597 if ( $user->idForName() == 0 ) {
1598 $user->addToDatabase();
1601 $user->setPassword( $this->getVar( '_AdminPassword' ) );
1602 } catch ( PasswordError
$pwe ) {
1603 return Status
::newFatal( 'config-admin-error-password', $name, $pwe->getMessage() );
1606 $user->addGroup( 'sysop' );
1607 $user->addGroup( 'bureaucrat' );
1608 if ( $this->getVar( '_AdminEmail' ) ) {
1609 $user->setEmail( $this->getVar( '_AdminEmail' ) );
1611 $user->saveSettings();
1613 // Update user count
1614 $ssUpdate = new SiteStatsUpdate( 0, 0, 0, 0, 1 );
1615 $ssUpdate->doUpdate();
1617 $status = Status
::newGood();
1619 if ( $this->getVar( '_Subscribe' ) && $this->getVar( '_AdminEmail' ) ) {
1620 $this->subscribeToMediaWikiAnnounce( $status );
1629 private function subscribeToMediaWikiAnnounce( Status
$s ) {
1631 'email' => $this->getVar( '_AdminEmail' ),
1636 // Mailman doesn't support as many languages as we do, so check to make
1637 // sure their selected language is available
1638 $myLang = $this->getVar( '_UserLang' );
1639 if ( in_array( $myLang, $this->mediaWikiAnnounceLanguages
) ) {
1640 $myLang = $myLang == 'pt-br' ?
'pt_BR' : $myLang; // rewrite to Mailman's pt_BR
1641 $params['language'] = $myLang;
1644 if ( MWHttpRequest
::canMakeRequests() ) {
1645 $res = MWHttpRequest
::factory( $this->mediaWikiAnnounceUrl
,
1646 [ 'method' => 'POST', 'postData' => $params ], __METHOD__
)->execute();
1647 if ( !$res->isOK() ) {
1648 $s->warning( 'config-install-subscribe-fail', $res->getMessage() );
1651 $s->warning( 'config-install-subscribe-notpossible' );
1656 * Insert Main Page with default content.
1658 * @param DatabaseInstaller $installer
1661 protected function createMainpage( DatabaseInstaller
$installer ) {
1662 $status = Status
::newGood();
1663 $title = Title
::newMainPage();
1664 if ( $title->exists() ) {
1665 $status->warning( 'config-install-mainpage-exists' );
1669 $page = WikiPage
::factory( $title );
1670 $content = new WikitextContent(
1671 wfMessage( 'mainpagetext' )->inContentLanguage()->text() . "\n\n" .
1672 wfMessage( 'mainpagedocfooter' )->inContentLanguage()->text()
1675 $status = $page->doEditContent( $content,
1679 User
::newFromName( 'MediaWiki default' )
1681 } catch ( Exception
$e ) {
1682 // using raw, because $wgShowExceptionDetails can not be set yet
1683 $status->fatal( 'config-install-mainpage-failed', $e->getMessage() );
1690 * Override the necessary bits of the config to run an installation.
1692 public static function overrideConfig() {
1693 // Use PHP's built-in session handling, since MediaWiki's
1694 // SessionHandler can't work before we have an object cache set up.
1695 define( 'MW_NO_SESSION_HANDLER', 1 );
1697 // Don't access the database
1698 $GLOBALS['wgUseDatabaseMessages'] = false;
1699 // Don't cache langconv tables
1700 $GLOBALS['wgLanguageConverterCacheType'] = CACHE_NONE
;
1702 $GLOBALS['wgShowExceptionDetails'] = true;
1703 // Don't break forms
1704 $GLOBALS['wgExternalLinkTarget'] = '_blank';
1706 // Extended debugging
1707 $GLOBALS['wgShowSQLErrors'] = true;
1708 $GLOBALS['wgShowDBErrorBacktrace'] = true;
1710 // Allow multiple ob_flush() calls
1711 $GLOBALS['wgDisableOutputCompression'] = true;
1713 // Use a sensible cookie prefix (not my_wiki)
1714 $GLOBALS['wgCookiePrefix'] = 'mw_installer';
1716 // Some of the environment checks make shell requests, remove limits
1717 $GLOBALS['wgMaxShellMemory'] = 0;
1719 // Override the default CookieSessionProvider with a dummy
1720 // implementation that won't stomp on PHP's cookies.
1721 $GLOBALS['wgSessionProviders'] = [
1723 'class' => 'InstallerSessionProvider',
1730 // Don't try to use any object cache for SessionManager either.
1731 $GLOBALS['wgSessionCacheType'] = CACHE_NONE
;
1735 * Add an installation step following the given step.
1737 * @param callable $callback A valid installation callback array, in this form:
1738 * [ 'name' => 'some-unique-name', 'callback' => [ $obj, 'function' ] ];
1739 * @param string $findStep The step to find. Omit to put the step at the beginning
1741 public function addInstallStep( $callback, $findStep = 'BEGINNING' ) {
1742 $this->extraInstallSteps
[$findStep][] = $callback;
1746 * Disable the time limit for execution.
1747 * Some long-running pages (Install, Upgrade) will want to do this
1749 protected function disableTimeLimit() {
1750 MediaWiki\
suppressWarnings();
1751 set_time_limit( 0 );
1752 MediaWiki\restoreWarnings
();